Sandbox docs: fix error in docs, add information around start_owner!/2 #665
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing moduledoc example for the sandbox doesn't work, as calling
checkout
and thenstart_owner!
results in the following error:I went digging for why
start_owner!/2
exists and did my best to distill down what I learned into its documentation, while also nixing its reference from moduledocs to fix the error in the example.That said, I'd very much appreciate any direction for better ways to document this information =) should start_owner! be prioritized over checkout in the moduledoc? i assumed no, since checkout is all-around simpler and more fool-proof.
as a note, we don't use
start_owner!
in our codebase but do have somelive(...)
calls - is the issue that caused the creation ofstart_owner!
still around? (in other words, does this even still need to exist?)